Skip to content

docs: 기본 README와 주요 안내를 영어로 전환 - #15

Merged
OstenHun merged 1 commit into
mainfrom
codex/english-documentation
Nov 16, 2026
Merged

OstenHun merged 1 commit into
mainfrom
codex/english-documentation

Conversation

@OstenHun

Copy link
Copy Markdown
Owner

요약

기본 README와 주요 안내 문서를 영어로 바꿉니다. 한국어 README·문서 색인은 별도 파일로 보존하고, 기존 영문 README 주소와 주요 절 링크도 유지합니다.

최신 공개 main의 구성에 맞춰 단일 danseo skill, 탐색·수집·분석·비교 CLI, 읽기 전용 비교 앱을 설명합니다. 기존 설치 안내와 공개 보안 신고 경로를 보존했으며, 로컬 개발 프리뷰의 카드 편집기·별도 Reading skill은 공개 기능으로 안내하지 않습니다.

참고한 README와 적용 방향

  • Meta Astryx: 짧은 소개·탐색 링크·시작 방법·구성 요소 설명
  • Anthropic Skills: 저장소 구성과 호스트별 skill 설치·호출 안내
  • Microsoft MarkItDown: 준비 사항·설치·실행 예제·기여 범위
  • Meta SAM 3: 첫 사용 흐름과 상세 문서의 분리

문서 배치를 참고했고 코드·이미지·제품 성과 문구는 복사하지 않았습니다. Danseo의 실제 구성, 원문과 AI 해석의 구분, 아직 한국어인 범위가 유지되는지를 리뷰 기준으로 삼았습니다.

검증

  • Windows / Node 24: 제품 테스트 86개와 portable evidence 테스트 33개 통과
  • npm run test:package: 설치본의 skill·주제 재개·PDF·분석·비교 흐름 통과
  • npm run check:docs: 상대 링크·이미지 340개와 요약 길이 통과
  • README 설치 예제: 격리된 PowerShell 경로 3곳과 Git Bash에서 파일 26개 일치·기존 설치 보존 확인
  • 변경 Markdown 13개의 절 링크 31개·주요 이전 앵커·패키지 포함 검사 통과
  • 로컬 Markdown 미리보기의 전체 안내 문서와 좁은 폭 README 읽기 확인
  • Claude Sonnet/medium 및 독립 Codex 리뷰 후 링크·과거 상태 안내·기존 앵커 제안 반영, 최종 재확인에서 조치가 필요한 결함 없음

앱 UI·진단·skill 실행 지침과 상세 문서는 일부 한국어로 남습니다. 실제 사용자 이해, native macOS/Linux 설치, GitHub 게시 화면은 위 로컬 검증과 구분합니다. 제품 실행 코드·스키마·의존성·lockfile 변경은 없습니다.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 16, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-16T02:29:26.770022Z ae003c6 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@claude

claude Bot commented Nov 16, 2026

Copy link
Copy Markdown

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

@OstenHun
OstenHun merged commit b39c54c into main Nov 16, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant